HySoP reference (auto generated) documentation¶
Generated according to version 2024.11
- hysop package
- hysop.backend package
- hysop.backend.device package
- hysop.backend.device.autotunable_kernel module
- hysop.backend.device.codegen package
- hysop.backend.device.codegen.base package
- hysop.backend.device.codegen.base.cl_extensions module
- hysop.backend.device.codegen.base.codegen module
- hysop.backend.device.codegen.base.enum_codegen module
- hysop.backend.device.codegen.base.function_codegen module
- hysop.backend.device.codegen.base.kernel_codegen module
- hysop.backend.device.codegen.base.opencl_codegen module
- hysop.backend.device.codegen.base.statistics module
- hysop.backend.device.codegen.base.struct_codegen module
- hysop.backend.device.codegen.base.union_codegen module
- hysop.backend.device.codegen.base.utils module
- hysop.backend.device.codegen.base.variables module
- hysop.backend.device.codegen.functions package
- hysop.backend.device.codegen.functions.advection_rhs module
- hysop.backend.device.codegen.functions.apply_stencil module
- hysop.backend.device.codegen.functions.cache_load module
- hysop.backend.device.codegen.functions.complex module
- hysop.backend.device.codegen.functions.compute_index module
- hysop.backend.device.codegen.functions.custom_atomics module
- hysop.backend.device.codegen.functions.directional_remesh module
- hysop.backend.device.codegen.functions.empty module
- hysop.backend.device.codegen.functions.gradient module
- hysop.backend.device.codegen.functions.polynomial module
- hysop.backend.device.codegen.functions.runge_kutta module
- hysop.backend.device.codegen.functions.stretching_rhs module
- hysop.backend.device.codegen.functions.vload module
- hysop.backend.device.codegen.functions.vstore module
- hysop.backend.device.codegen.kernels package
- hysop.backend.device.codegen.kernels.bandwidth module
- hysop.backend.device.codegen.kernels.copy_kernel module
- hysop.backend.device.codegen.kernels.custom_symbolic module
- hysop.backend.device.codegen.kernels.directional_advection module
- hysop.backend.device.codegen.kernels.directional_remesh module
- hysop.backend.device.codegen.kernels.directional_stretching module
- hysop.backend.device.codegen.kernels.empty module
- hysop.backend.device.codegen.kernels.stretching module
- hysop.backend.device.codegen.kernels.transpose module
- hysop.backend.device.codegen.structs package
- hysop.backend.device.codegen.structs.indices module
- hysop.backend.device.codegen.structs.mesh_info module
- hysop.backend.device.codegen.symbolic package
- hysop.backend.device.codegen.symbolic.cast module
- hysop.backend.device.codegen.symbolic.expr module
BuiltinFunction
BuiltinFunctionCall
ComplexFloatingPointConstant
FloatingPointConstant
FunctionCall
IfElse
IntegerConstant
NumericalConstant
OpenClAssignment
OpenClBool
OpenClCast
OpenClConvert
OpenClIndexedVariable
OpenClPrinter
OpenClVariable
Return
TypedExpr
TypedExprWrapper
TypedI
TypedSymbol
UpdateVars
VLoad
VLoadIf
VStore
VStoreIf
- hysop.backend.device.codegen.symbolic.functions package
- hysop.backend.device.codegen.symbolic.functions.apply_stencil module
- hysop.backend.device.codegen.symbolic.functions.custom_symbolic_function module
- hysop.backend.device.codegen.symbolic.kernels package
- hysop.backend.device.codegen.symbolic.kernels.custom_symbolic_affect module
- hysop.backend.device.codegen.symbolic.kernels.custom_symbolic_time_integrate module
- hysop.backend.device.codegen.symbolic.map module
- hysop.backend.device.codegen.symbolic.misc module
- hysop.backend.device.codegen.symbolic.relational module
- hysop.backend.device.codegen.unions package
- hysop.backend.device.codegen.unions.float_int module
- hysop.backend.device.device_allocator module
- hysop.backend.device.device_buffer module
- hysop.backend.device.device_info module
- hysop.backend.device.device_operators module
- hysop.backend.device.device_platform module
- hysop.backend.device.kernel_autotuner module
- hysop.backend.device.kernel_autotuner_config module
- hysop.backend.device.kernel_autotuner_statistics module
- hysop.backend.device.kernel_config module
- hysop.backend.device.kernel_statistics module
- hysop.backend.device.logical_device module
- hysop.backend.device.opencl package
- hysop.backend.device.opencl.autotunable_kernels package
- hysop.backend.device.opencl.autotunable_kernels.advection_dir module
- hysop.backend.device.opencl.autotunable_kernels.custom_symbolic module
- hysop.backend.device.opencl.autotunable_kernels.remesh_dir module
- hysop.backend.device.opencl.autotunable_kernels.transpose module
- hysop.backend.device.opencl.clpeak module
- hysop.backend.device.opencl.opencl_allocator module
- hysop.backend.device.opencl.opencl_array module
- hysop.backend.device.opencl.opencl_array_backend module
- hysop.backend.device.opencl.opencl_autotunable_kernel module
- hysop.backend.device.opencl.opencl_buffer module
- hysop.backend.device.opencl.opencl_copy_kernel_launchers module
- hysop.backend.device.opencl.opencl_device module
- hysop.backend.device.opencl.opencl_elementwise module
- hysop.backend.device.opencl.opencl_env module
- hysop.backend.device.opencl.opencl_fft module
- hysop.backend.device.opencl.opencl_hardware_backend module
- hysop.backend.device.opencl.opencl_kernel module
- hysop.backend.device.opencl.opencl_kernel_autotuner module
- hysop.backend.device.opencl.opencl_kernel_autotuner_config module
- hysop.backend.device.opencl.opencl_kernel_config module
- hysop.backend.device.opencl.opencl_kernel_launcher module
- hysop.backend.device.opencl.opencl_kernel_statistics module
- hysop.backend.device.opencl.opencl_mempool module
- hysop.backend.device.opencl.opencl_operator module
- hysop.backend.device.opencl.opencl_operators module
- hysop.backend.device.opencl.opencl_platform module
- hysop.backend.device.opencl.opencl_printer module
- hysop.backend.device.opencl.opencl_symbolic module
- hysop.backend.device.opencl.opencl_tools module
- hysop.backend.device.opencl.opencl_types module
OpenClTypeGen
TypeGen
basetype()
cl_type_to_dtype()
cl_vec_type_to_scalar_and_count()
components()
doublen()
float_to_dec_str()
float_to_hex_str()
intn()
itype()
make_doublen()
make_intn()
make_simplen()
make_typen()
make_uintn()
mangle_vtype()
np_dtype()
npmake()
simplen()
typen()
uintn()
uitype()
vtype()
vtype_access()
vtype_component_adressing()
- hysop.backend.device.opencl.operator package
- hysop.backend.device.opencl.operator.analytic module
- hysop.backend.device.opencl.operator.curl module
- hysop.backend.device.opencl.operator.custom module
- hysop.backend.device.opencl.operator.custom_symbolic module
- hysop.backend.device.opencl.operator.derivative module
- hysop.backend.device.opencl.operator.diffusion module
- hysop.backend.device.opencl.operator.directional package
- hysop.backend.device.opencl.operator.directional.advection_dir module
- hysop.backend.device.opencl.operator.directional.opencl_directional_operator module
- hysop.backend.device.opencl.operator.directional.stretching_dir module
- hysop.backend.device.opencl.operator.enstrophy module
- hysop.backend.device.opencl.operator.external_force module
- hysop.backend.device.opencl.operator.integrate module
- hysop.backend.device.opencl.operator.memory_reordering module
- hysop.backend.device.opencl.operator.min_max module
- hysop.backend.device.opencl.operator.poisson module
- hysop.backend.device.opencl.operator.poisson_curl module
- hysop.backend.device.opencl.operator.solenoidal_projection module
- hysop.backend.device.opencl.operator.spatial_filtering module
- hysop.backend.device.opencl.operator.transpose module
- hysop.backend.discover module
- hysop.backend.hardware package
- hysop.backend.hardware.cpu module
- hysop.backend.hardware.hardware_backend module
- hysop.backend.hardware.hwinfo module
- hysop.backend.hardware.machine module
- hysop.backend.hardware.pci module
- hysop.backend.hardware.pci_ids module
- hysop.backend.host package
- hysop.backend.host.cpp package
- hysop.backend.host.cpp.cpp_operators module
- hysop.backend.host.fortran package
- hysop.backend.host.fortran.fortran_operator module
- hysop.backend.host.fortran.fortran_operators module
- hysop.backend.host.fortran.operator package
- hysop.backend.host.fortran.operator.diffusion module
- hysop.backend.host.fortran.operator.fortran_fftw module
- hysop.backend.host.fortran.operator.poisson module
- hysop.backend.host.fortran.operator.poisson_curl module
- hysop.backend.host.fortran.operator.scales_advection module
- hysop.backend.host.host_allocator module
- hysop.backend.host.host_array module
- hysop.backend.host.host_array_backend module
- hysop.backend.host.host_buffer module
- hysop.backend.host.host_directional_operator module
- hysop.backend.host.host_mempool module
- hysop.backend.host.host_operator module
- hysop.backend.host.host_operators module
- hysop.backend.host.python package
- hysop.backend.host.python.operator package
- hysop.backend.host.python.operator.analytic module
- hysop.backend.host.python.operator.convergence module
- hysop.backend.host.python.operator.curl module
- hysop.backend.host.python.operator.custom module
- hysop.backend.host.python.operator.derivative module
- hysop.backend.host.python.operator.diffusion module
- hysop.backend.host.python.operator.directional package
- hysop.backend.host.python.operator.directional.advection_dir module
- hysop.backend.host.python.operator.directional.stretching_dir module
- hysop.backend.host.python.operator.enstrophy module
- hysop.backend.host.python.operator.flowrate_correction module
- hysop.backend.host.python.operator.integrate module
- hysop.backend.host.python.operator.memory_reordering module
- hysop.backend.host.python.operator.min_max module
- hysop.backend.host.python.operator.penalization module
- hysop.backend.host.python.operator.poisson module
- hysop.backend.host.python.operator.poisson_curl module
- hysop.backend.host.python.operator.solenoidal_projection module
- hysop.backend.host.python.operator.spatial_filtering module
- hysop.backend.host.python.operator.transpose module
- hysop.backend.host.python.operator.vorticity_absorption module
- hysop.backend.host.python.python_operators module
- hysop.backend.operators module
- hysop.constants module
AutotunerFlags
Backend
BoundaryCondition
BoundaryConditionConfig
BoxBoundaryCondition
CacheType
ComputeGranularity
DeviceType
DirectionLabels
Directions
FieldProjection
FpConfig
HYSOP_BOOL
HYSOP_COMPLEX
HYSOP_DEFAULT_TASK_ID
HYSOP_DIM
HYSOP_EPS
HYSOP_INDEX
HYSOP_INTEGER
HYSOP_MPI_INTEGER
HYSOP_MPI_REAL
HYSOP_ORDER
HYSOP_REAL
Implementation
MemoryOrdering
MemoryType
PenalizationFormulation
Precision
ResidualError
SIZEOF_HYSOP_BOOL
SIZEOF_HYSOP_COMPLEX
SIZEOF_HYSOP_DIM
SIZEOF_HYSOP_INDEX
SIZEOF_HYSOP_INTEGER
SIZEOF_HYSOP_REAL
SpaceDiscretization
StretchingFormulation
SymbolicExpressionKind
System
TimeIntegratorsOptimisationLevel
boundary2str()
default_order
format_boundaries()
implementation_to_backend()
- hysop.core package
- hysop.core.arrays package
- hysop.core.arrays.all module
- hysop.core.arrays.array module
- hysop.core.arrays.array_backend module
- hysop.core.checkpoints module
- hysop.core.graph package
- hysop.core.graph.all module
- hysop.core.graph.allocator module
- hysop.core.graph.computational_graph module
- hysop.core.graph.computational_node module
- hysop.core.graph.computational_node_frontend module
- hysop.core.graph.computational_operator module
- hysop.core.graph.continuous module
- hysop.core.graph.graph module
ComputationalGraphNodeData
EdgeAttributes
VertexAttributes
all_simple_paths()
discretized()
generate_vertex_colors()
generated()
graph_built()
initialized()
is_directed_acyclic_graph()
lexicographical_topological_sort()
new_directed_graph()
new_edge()
new_vertex()
not_initialized()
op_apply()
ready()
transitive_reduction()
- hysop.core.graph.graph_builder module
- hysop.core.graph.node_generator module
- hysop.core.graph.node_requirements module
- hysop.core.memory package
- hysop.core.memory.allocator module
- hysop.core.memory.buffer module
- hysop.core.memory.mem_utils module
- hysop.core.memory.memory_request module
- hysop.core.memory.mempool module
- hysop.core.mpi package
- hysop.core.mpi.bridge module
- hysop.core.mpi.redistribute module
- hysop.core.mpi.topo_tools module
- hysop.defaults module
- hysop.domain package
- hysop.domain.box module
- hysop.domain.control_box module
- hysop.domain.domain module
- hysop.domain.porous module
- hysop.f2hysop module
- hysop.fields package
- hysop.fields.cartesian_discrete_field module
- hysop.fields.continuous_field module
- hysop.fields.default_fields module
- hysop.fields.discrete_field module
- hysop.fields.field_requirements module
- hysop.fields.ghost_exchangers module
- hysop.fields.variable_parameter module
- hysop.iterative_method module
- hysop.mesh package
- hysop.mesh.cartesian_mesh module
- hysop.mesh.mesh module
- hysop.methods module
- hysop.numerics package
- hysop.numerics.fft package
- hysop.numerics.fft.fft module
- hysop.numerics.fft.fftw_fft module
- hysop.numerics.fft.gpyfft_fft module
- hysop.numerics.fft.host_fft module
- hysop.numerics.fft.numpy_fft module
- hysop.numerics.fft.opencl_fft module
- hysop.numerics.fft.scipy_fft module
- hysop.numerics.interpolation package
- hysop.numerics.interpolation.interpolation module
- hysop.numerics.interpolation.polynomial module
- hysop.numerics.odesolvers package
- hysop.numerics.odesolvers.runge_kutta module
- hysop.numerics.odesolvers.runge_kutta_coeffs module
- hysop.numerics.remesh package
- hysop.numerics.remesh.kernel_generator module
- hysop.numerics.remesh.remesh module
- hysop.numerics.splitting package
- hysop.numerics.splitting.directional_splitting module
- hysop.numerics.splitting.strang module
- hysop.numerics.stencil package
- hysop.numerics.stencil.stencil module
- hysop.numerics.stencil.stencil_generator module
- hysop.operator package
- hysop.operator.adapt_timestep module
- hysop.operator.advection module
- hysop.operator.analytic module
- hysop.operator.base package
- hysop.operator.base.advection_dir module
- hysop.operator.base.convergence module
- hysop.operator.base.curl module
- hysop.operator.base.custom module
- hysop.operator.base.custom_symbolic_operator module
- hysop.operator.base.derivative module
- hysop.operator.base.diffusion module
- hysop.operator.base.enstrophy module
- hysop.operator.base.external_force module
- hysop.operator.base.integrate module
- hysop.operator.base.memory_reordering module
- hysop.operator.base.min_max module
- hysop.operator.base.poisson module
- hysop.operator.base.poisson_curl module
- hysop.operator.base.redistribute_operator module
- hysop.operator.base.solenoidal_projection module
- hysop.operator.base.spatial_filtering module
- hysop.operator.base.spectral_operator module
- hysop.operator.base.stretching_dir module
- hysop.operator.base.transpose_operator module
- hysop.operator.convergence module
- hysop.operator.curl module
- hysop.operator.custom module
- hysop.operator.custom_symbolic module
- hysop.operator.derivative module
- hysop.operator.diffusion module
- hysop.operator.directional package
- hysop.operator.directional.advection_dir module
- hysop.operator.directional.all module
- hysop.operator.directional.diffusion_dir module
- hysop.operator.directional.directional module
- hysop.operator.directional.stretching_diffusion_dir module
- hysop.operator.directional.stretching_dir module
- hysop.operator.directional.symbolic_dir module
- hysop.operator.dummy module
- hysop.operator.enstrophy module
- hysop.operator.external_force module
- hysop.operator.flowrate_correction module
- hysop.operator.gradient module
- hysop.operator.hdf_io module
- hysop.operator.integrate module
- hysop.operator.kinetic_energy module
- hysop.operator.mean_field module
- hysop.operator.memory_reordering module
- hysop.operator.min_max module
- hysop.operator.misc module
- hysop.operator.parameter_plotter module
- hysop.operator.penalization module
- hysop.operator.plotters module
- hysop.operator.poisson module
- hysop.operator.poisson_curl module
- hysop.operator.redistribute module
- hysop.operator.reductions module
- hysop.operator.solenoidal_projection module
- hysop.operator.spatial_filtering module
- hysop.operator.transpose module
- hysop.operator.vorticity_absorption module
- hysop.operators module
- hysop.parameters package
- hysop.parameters.buffer_parameter module
- hysop.parameters.default_parameters module
- hysop.parameters.parameter module
- hysop.parameters.scalar_parameter module
- hysop.parameters.tensor_parameter module
- hysop.problem module
- hysop.simulation module
- hysop.symbolic package
- hysop.symbolic.array module
- hysop.symbolic.base module
- hysop.symbolic.complex module
- hysop.symbolic.constant module
- hysop.symbolic.directional module
- hysop.symbolic.field module
- hysop.symbolic.frame module
- hysop.symbolic.func module
- hysop.symbolic.misc module
- hysop.symbolic.parameter module
- hysop.symbolic.relational module
Add
AddAugmentedAssignment
ArithmeticRelation
Assignment
AugmentedAssignment
BinaryFunction
BinaryRelation
DivAugmentedAssignment
LogicalAND
LogicalEQ
LogicalGE
LogicalGT
LogicalLE
LogicalLT
LogicalNE
LogicalOR
LogicalRelation
LogicalXOR
Max
Min
ModAugmentedAssignment
Mul
MulAugmentedAssignment
NAryFunction
NAryRelation
Pow
Round
SubAugmentedAssignment
UnaryFunction
- hysop.symbolic.spectral module
- hysop.symbolic.tmp module
- hysop.tools package
- hysop.tools.cache module
- hysop.tools.callback module
- hysop.tools.contexts module
- hysop.tools.debug_dumper module
- hysop.tools.debug_utils module
- hysop.tools.decorators module
- hysop.tools.field_utils module
BasePrinter
DifferentialStringFormatter
LatexNamePrinter
NamePrinter
PrettyNamePrinter
VarNamePrinter
bcomp_fn()
bdivide_fn()
bexp_fn()
bjoin_fn()
bpow_fn()
bsub_fn()
lcomp_fn()
ldivide_fn()
lexp_fn()
ljoin_fn()
lpow_fn()
lsub_fn()
pcomp_fn()
pdivide_fn()
pexp_fn()
pjoin_fn()
ppow_fn()
print_all_names()
print_latex_name()
print_name()
print_pretty_name()
print_var_name()
psub_fn()
to_str()
vcomp_fn()
vdivide_fn()
vexp_fn()
vjoin_fn()
vpow_fn()
vsub_fn()
- hysop.tools.handle module
- hysop.tools.hash module
- hysop.tools.henum module
- hysop.tools.hptt_utils module
- hysop.tools.htypes module
- hysop.tools.hysop_ls module
- hysop.tools.indices module
- hysop.tools.interface module
- hysop.tools.io_utils module
- hysop.tools.method_utils module
- hysop.tools.misc module
- hysop.tools.mpi_utils module
- hysop.tools.numba_utils module
- hysop.tools.numerics module
complex_to_float_dtype()
default_invalid_value()
demote_dtype()
determine_fp_types()
find_common_dtype()
float_to_complex_dtype()
get_dtype()
get_itemsize()
is_complex()
is_fp()
is_integer()
is_signed()
is_unsigned()
match_bool_type()
match_complex_type()
match_dtype()
match_float_type()
match_signed_type()
match_unsigned_type()
- hysop.tools.numpywrappers module
- hysop.tools.opencl_explore module
- hysop.tools.parameters module
- hysop.tools.plotDrag module
- hysop.tools.profiler module
- hysop.tools.spectral_utils module
- hysop.tools.string_utils module
- hysop.tools.sympy_utils module
AppliedUndef
CustomLatexPrinter
CustomStrPrinter
CustomStrReprPrinter
Dummy
Expr
SetupExprI
Symbol
SymbolicBase
UndefinedFunction
UnevaluatedExpr
UnsplittedExpr
build_eqs_from_dicts()
enable_pretty_printing()
evalf_str()
exponent()
exponents()
factor_split()
get_derivative_variables()
latex()
non_eval_xreplace()
recurse_expression_tree()
remove_pows()
round_expr()
sstr()
sstrrepr()
subscript()
subscripts()
tensor_symbol()
tensor_xreplace()
truncate_expr()
- hysop.tools.sys_utils module
- hysop.tools.transposition_states module
- hysop.tools.units module
- hysop.tools.variable module
- hysop.tools.warning module
- hysop.topology package
- hysop.topology.cartesian_descriptor module
- hysop.topology.cartesian_topology module
- hysop.topology.topology module
- hysop.topology.topology_descriptor module
- Fortran, C/C++ API